
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>TAMOC User Manual &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Ambient Module Users Guide" href="guides/ambient.html" />
    <link rel="prev" title="Texas A&amp;M Oil spill / Outfall Calculator (TAMOC)" href="index.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="tamoc-user-manual">
<h1>TAMOC User Manual<a class="headerlink" href="#tamoc-user-manual" title="Permalink to this headline">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Release</dt>
<dd class="field-odd"><p>2.1</p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>Jun 05, 2020</p>
</dd>
</dl>
<div class="section" id="user-s-guides">
<h2>User’s Guides<a class="headerlink" href="#user-s-guides" title="Permalink to this headline">¶</a></h2>
<p>A few examples of how to use the modules in <code class="docutils literal notranslate"><span class="pre">TAMOC</span></code> are provided in the
following user guides along with comprehensive references to the included
<code class="docutils literal notranslate"><span class="pre">./bin</span></code> scripts.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="guides/ambient.html">Ambient Module Users Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/ambient.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/ambient.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/seawater.html">Seawater Module Users Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/seawater.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/chem.html">Chemical Properties Users Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/chem.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/chem.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/chem.html#usage-within-tamoc">Usage within <code class="docutils literal notranslate"><span class="pre">TAMOC</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/chem.html#usage-to-import-user-defined-data">Usage to Import User-Defined Data</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/dbm.html">Discrete Bubble Model Users Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/dbm.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/dbm.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/disp_phases.html">Dispersed Phases User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/disp_phases.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/disp_phases.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/sintef.html">Sintef Module User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/sintef.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/sintef.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/psm.html">Particle Size Models User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/psm.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/psm.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/params.html">Params Module User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/params.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/params.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/sbm.html">Single Bubble Model Users Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/sbm.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/sbm.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/spm.html">Stratified Plume Model User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/spm.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/spm.html#notebooks">Notebooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/spm.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/bpm.html">Bent Plume Model User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/bpm.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/bpm.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="guides/blowout.html">Blowout Module User’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/blowout.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/blowout.html#examples">Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="module-documentation">
<h2>Module Documentation<a class="headerlink" href="#module-documentation" title="Permalink to this headline">¶</a></h2>
<p>Each of the modules, classes, methods, and functions provided with <code class="docutils literal notranslate"><span class="pre">TAMOC</span></code>
are throughly documented in the source code.  The following pages collect
this source code documentation for web presentation.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/seawater.html">Overview of the Seawater Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/seawater.html#equations-of-state-for-seawater">Equations of State for Seawater</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/seawater.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/ambient.html">Overview of Ambient Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/ambient.html#ambient-module">Ambient Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/ambient.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/ambient.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/chem.html">Overview of Chemical Properties</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/chem.html#chemical-properties-script">Chemical Properties Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/chem.html#module-functions">Module Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/chem.html#input-data-documentation">Input Data Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/dbm.html">Overview of the Discrete Bubble Model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/dbm.html#dbm-module">DBM Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/dbm.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/dbm.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/dbm_utils.html">Overview of DBM Utilities Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/dbm_utils.html#discrete-bubble-model-utilities">Discrete Bubble Model Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/dbm_utils.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/disp_phases.html">Overview of Dispersed Phases Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/disp_phases.html#dispersed-phases">Dispersed Phases</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/disp_phases.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/disp_phases.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/sintef.html">Overview of SINTEF Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/sintef.html#sintef">Sintef</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/sintef.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/particle_size_models.html">Overview of Particle Size Models Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/particle_size_models.html#particle-size-models">Particle Size Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/particle_size_models.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/particle_size_models.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/params.html">Overview of Parameters Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/params.html#params-module">Params Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/params.html#class-objects-and-methods">Class Objects and Methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/sbm.html">Overview of Single Bubble Model Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/sbm.html#single-bubble-model">Single Bubble Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/sbm.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/sbm.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/spm.html">Overview of Stratified Plume Model Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/spm.html#stratified-plume-model">Stratified Plume Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/spm.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/spm.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/bpm.html">Overview of Bent Plume Model Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/bpm.html#bent-plume-model">Bent Plume Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/bpm.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/bpm.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/model_share.html">Overview of Model Share Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/model_share.html#model-share">Model Share</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/model_share.html#module-functions">Module Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/blowout.html">Overview of Blowout Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/blowout.html#blowout-module">Blowout Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/blowout.html#class-objects-and-methods">Class Objects and Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/blowout.html#module-functions">Module Functions</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="index.html" title="previous chapter">Texas A&amp;M Oil spill / Outfall Calculator (TAMOC)</a></li>
      <li>Next: <a href="guides/ambient.html" title="next chapter">Ambient Module Users Guide</a></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="_sources/user_manual.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>